Skip to content

run vale in docker #23101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
crazy-max merged 1 commit into from
Jul 17, 2025
Merged

run vale in docker #23101

crazy-max merged 1 commit into from
Jul 17, 2025

Conversation

@crazy-max
Copy link
Member

@crazy-max crazy-max commented Jul 16, 2025 •
edited
Loading

Description

Atm vale only runs in GitHub Actions:

docs/.github/workflows/build.yml

Lines 71 to 80 in c69c0b5

vale:
if: ${{ github.event_name == 'pull_request' }}
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: errata-ai/vale-action@reviewdog
env:
PIP_BREAK_SYSTEM_PACKAGES: 1
with:
files: content

With this change we are now able to run vale locally using bake:

$ docker buildx bake vale
...
#12 15.64  content/reference/compose-file/build.md
#12 15.64  256:58  error  Did you really mean 'inlined'?  Vale.Spelling
#12 15.64
#12 15.64
#12 15.64  content/reference/compose-file/services.md
#12 15.64  1730:33   error       Did you really mean             Vale.Spelling
#12 15.64                        'post_start'?
#12 15.64  1914:208  suggestion  Consider using 'let' instead    Docker.RecommendedWords
#12 15.64                        of 'allow'
#12 15.64  2008:35   error       Did you really mean             Vale.Spelling
#12 15.64                        'namespaced'?
#12 15.64  2010:59   error       Did you really mean             Vale.Spelling
#12 15.64                        'namespaced'?
#12 15.64  2130:10   error       Did you really mean 'SELinux'?  Vale.Spelling
#12 15.64  2131:10   error       Did you really mean 'SELinux'?  Vale.Spelling
#12 15.64  2135:7    error       Did you really mean 'SELinux'?  Vale.Spelling
#12 15.64  2135:77   error       Did you really mean 'SELinux'?  Vale.Spelling
#12 15.64  2163:20   error       Did you really mean 'SELinux'?  Vale.Spelling
#12 15.64
#12 15.64 ✖ 5489 errors, 2404 warnings and 1541 suggestions in 1367 files.
#12 DONE 17.5s

#13 [vale 1/1] COPY --from=vale-run /out/vale.out /
#13 DONE 0.0s

#14 exporting to client directory
#14 copying files 1.23MB 0.0s done
#14 DONE 0.0s

When running in GitHub Actions it will change the output format so reviewdog can create GitHub Annotations on pull request event. Having a dedicated step running reviewdog avoids the clunky output we have when running vale-action. Now are just displayed issues related to the pull request opened.

See for example: https://github.com/docker/docs/actions/runs/16320531091/job/46096850578#step:6:1

image

cc @dvdksn if you are interested to review this 🤗

Reviews

  • Technical review
  • Editorial review
  • Product review

@netlify
Copy link

netlify bot commented Jul 16, 2025 •
edited
Loading

✅ Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 04b56a6
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6877a6b35f61e5000790be2a
😎 Deploy Preview https://deploy-preview-23101--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added area/release Relates to CI or deployment area/config labels Jul 16, 2025
@crazy-max
run vale in docker
04b56a6 
Signed-off-by: CrazyMax <[email protected]>
@github-actions github-actions bot added the area/build Relates to Dockerfiles or docker build command label Jul 16, 2025
@crazy-max crazy-max marked this pull request as ready for review July 16, 2025 13:20
ArthurFlag
ArthurFlag approved these changes Jul 17, 2025
View reviewed changes
Copy link
Contributor

@ArthurFlag ArthurFlag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @crazy-max 🚀

@crazy-max crazy-max merged commit 9f6b1a0 into docker:main Jul 17, 2025
25 of 26 checks passed
@crazy-max crazy-max deleted the vale-dockerfile branch July 17, 2025 08:01
@ArthurFlag ArthurFlag mentioned this pull request Jul 17, 2025
Closed
3 tasks
@dvdksn
Copy link
Contributor

dvdksn commented Jul 18, 2025

This is beautiful ❤️

@T3d1pi

This comment was marked as spam.

Sign in to view
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thaJeztah thaJeztah Awaiting requested review from thaJeztah

@usha-mandya usha-mandya Awaiting requested review from usha-mandya

@aevesdocker aevesdocker Awaiting requested review from aevesdocker

@sarahsanders-docker sarahsanders-docker Awaiting requested review from sarahsanders-docker

1 more reviewer

@ArthurFlag ArthurFlag ArthurFlag approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area/build Relates to Dockerfiles or docker build command area/config area/release Relates to CI or deployment

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@crazy-max @dvdksn @T3d1pi @ArthurFlag